collapse-white-space
Advanced tools
Package description
The collapse-white-space npm package is designed to reduce multiple whitespace characters in a string down to a single space, effectively 'collapsing' them. This can be particularly useful for cleaning up strings in web development contexts, such as user input or text content processing, where consistent whitespace handling is desired.
Collapsing multiple whitespace characters
This feature allows you to take a string with multiple spaces, tabs, or other whitespace characters and reduce them to a single space between words or characters. It's particularly useful for text normalization.
"use strict";\nconst collapse = require('collapse-white-space');\nconst text = 'This is a test string.';\nconsole.log(collapse(text)); // 'This is a test string.'Similar to collapse-white-space, this package removes all unnecessary whitespace from a string, but it also trims the string, removing whitespace from the beginning and end. This makes it slightly more aggressive in whitespace removal compared to collapse-white-space, which preserves leading and trailing whitespace.
The trim package offers functionality to remove leading and trailing whitespace from a string. While it doesn't collapse internal whitespace, it's often used in conjunction with other methods to clean up strings. It's more focused compared to collapse-white-space, which handles internal whitespace collapsing.
Readme
Collapse white space.
This is a small package that collapses multiple white space characters into one.
You can use this package if you want to HTML or JavaScript (default) white space to a single character. You can optionally drop initial and final white space. By default it collapses to a single space, but optionally line endings can be preserved.
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install collapse-white-space
In Deno with Skypack:
import {collapseWhiteSpace} from 'https://cdn.skypack.dev/collapse-white-space@2?dts'
In browsers with Skypack:
<script type="module">
import {collapseWhiteSpace} from 'https://cdn.skypack.dev/collapse-white-space@2?min'
</script>
import {collapseWhiteSpace} from 'collapse-white-space'
collapseWhiteSpace('\tfoo \n\tbar \t\r\nbaz') //=> ' foo bar baz'
This package exports the following identifier: collapseWhiteSpace.
There is no default export.
collapseWhiteSpace(value[, options|style])Collapse white space in value (string).
styleTreated as options.style.
optionsConfiguration.
options.styleStyle of white space to support ('html' or 'js', default: 'js').
JavaScript white space matches the pattern \s+.
HTML white space matches [\t\n\v\f\r ].
options.preserveLineEndingsWhether to collapse white space containing a line ending to that line ending
(boolean, default: false).
The default is to collapse to a single space.
Line endings matches the pattern \r?\n|\r.
options.trimWhether to drop white space at the start and end of value (boolean, default:
false).
The default is to keep it.
string – value with collapsed white space.
This package is fully typed with TypeScript.
It exports Options and Style types, which specify the interface of the
accepted options.
This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. It also works in Deno and modern browsers.
This package is safe.
wooorm/is-whitespace-character
— check if a character is a white space characterwooorm/detab
— convert tabs to spaceswooorm/trim-lines
— remove tabs and spaces around line-breaksYes please! See How to Contribute to Open Source.
FAQs
Collapse white space
The npm package collapse-white-space receives a total of 2,184,143 weekly downloads. As such, collapse-white-space popularity was classified as popular.
We found that collapse-white-space demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.